vcProcessManager

The process manager service automatically creates, updates and removes process groups when process implementations are added, renamed or removed within its parent process controller. The process groups can be used to easily find all implementations of a process.

See in: Overview

Module: vcProcessModel

Parent: vcObject

Children -

Referenced by: vcProcessController.ProcessManager

Properties

Learn how to use properties here. The properties are also inherited from the parent class.

NameTypeAccessDescription
ProcessGroupsvcList[vcProcessGroup]RGets an observable list of all current processes in this process controller.

Methods

Learn how to use methods here. The methods are also inherited from the parent class.

NameReturn TypeParametersDescription
changeGroupIdNonevcProcessGroup group,
String newId
Tries to rename a process i.e. change id of all process implementations in a process group.
See more
Parameters:
group (vcProcessGroup): The process group to change the id of.
newId (String): The new id.

Exceptions:
ValueError: When the new process id is empty.
ValueError: When the new process id already exists in some executor's processes.
findProcessGroupvcProcessGroupString processIdTries to find a process group that contains all processes with the given id.
See more
Parameters:
processId (String): Id to search for.

Returns:
vcProcessGroup: The found process group or None.

Events

Learn how to use events here. The events are also inherited from the parent class.

NameParametersDescription
OnGroupIdChangedvcProcessGroup group,
String previousId
Triggered when all processes within a group changed their id.
See more
Parameters:
group (vcProcessGroup): The target process group.
previousId (String): The group's Id before changes.
OnProcessAddedvcProcessRoutine process,
vcProcessGroup group
Triggered when a new process implementation has been added.
See more
Parameters:
process (vcProcessRoutine): The target process routine.
group (vcProcessGroup): The target process group.
OnProcessRemovingvcProcessRoutine process,
vcProcessGroup group
Triggered when a process implementation is about to be removed.
See more
Parameters:
process (vcProcessRoutine): The target process routine.
group (vcProcessGroup): The target process group.